home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / txtedtrs / qroff / qroff.doc < prev    next >
Text File  |  1995-05-02  |  3KB  |  113 lines
  1. QROFF (1O)                            QROFF (1O)
  2.  
  3. SYNOPSIS
  4.     qroff - world's dumbest formatter
  5.  
  6. USAGE
  7.     qroff [file ...]
  8.  
  9. DESCRIPTION
  10.     Qroff is an upwardly mobile paragraph formatter.  It was written
  11.     as a fast way to get all of the Stadel documentation into a
  12.     coherent style, and only supports the bare minimum of commands
  13.     needed to do that.  It works like most other formatters - it
  14.     does its actions based on commands in the text, plus commands
  15.     in a predefined style sheet.
  16.  
  17.     Qroff takes as input a free-format input and formats it into
  18.     a collection of right & left justified paragraphs.  Qroff
  19.     considers blank lines in the input to be paragraph breaks
  20.     (as well as a few of the formatting commands listed below),
  21.     and lines beginning with a $ to be formatting commands.
  22.     
  23. FORMATTING COMMANDS
  24.     Formatting commands use a line of their own, and begin with
  25.     a $.  In most cases, they do not cause paragraph breaks,
  26.     but just change various qroff things and continue merrily
  27.     along their way.
  28.  
  29.     $include <filename>
  30.         Include this file into your document, formatted like
  31.         everything else.  You may nest $includes up to 10
  32.         levels deep.
  33.         
  34.     $section <level> <title>
  35.         Produces a section title; Section #'s are nestable
  36.         up to 10 levels deep, and are kept track of internally.
  37.         A section title looks like:
  38.  
  39.         #.#.#.#) title
  40.  
  41.         Where the #'s are the current section and subsection #'s.
  42.  
  43.         Here's a brief example of sections; the following text:
  44.  
  45.         $section 0 Introduction
  46.         $section 1 Synopsis
  47.         $section 1 Usage
  48.         $section 0 History
  49.         $section 1 Origins
  50.         $section 1 Evolution
  51.  
  52.         produces the following output:
  53.  
  54.         1) Introduction
  55.         1.1) Synopsis
  56.         1.2) Usage
  57.         2) History
  58.         2.1) Origins
  59.         2.2) Evolution.
  60.  
  61.         (Notice that when we changed from section 1 to 2,
  62.         the subsection # reverted to 1)
  63.  
  64.     $raw    Don't process the text between this line and end
  65.         of file or a $cooked directive.
  66.  
  67.     $cooked    Resume formatting after a $raw
  68.  
  69.     $left <margin>
  70.         Adjust or set the left margin.  If you prefix the
  71.         margin with a + or -, qroff adjusts the margin by
  72.         that amount, otherwise it will set the margin to
  73.         that number.  If your new margin setting is further
  74.         right than the right margin, qroff will complain
  75.         and ignore the offending command.
  76.  
  77.     $right <margin>
  78.         Adjust or set the right margin.  Otherwise like the
  79.         $left command.
  80.  
  81.     $indent <para-indent>
  82.         Set the paragraph indent (the amount of space the
  83.         first line of a paragraph is indented past the
  84.         left margin.)  You may generate "hanging" paragraphs
  85.         by setting the para-indent to a negative number.
  86.  
  87.     $skip <lines>
  88.         Output a few blank lines.
  89.  
  90.     $par    Forces a paragraph break.  Normally, paragraphs are
  91.         separated by blank lines, but there might be stylistic
  92.         reasons against that.  So...
  93.  
  94.         (The commands $section, $skip,  and $raw also force
  95.         paragraph breaks)
  96.  
  97.  
  98. STYLE SHEETS
  99.     Qroff starts up with a default configuration of
  100.     $left 4
  101.     $right 70
  102.     $indent 4
  103.  
  104.     but if you don't find this to your liking, you may create style
  105.     sheets to alter the behavior of qroff.  When qroff starts up,
  106.     it looks for the file STYLE.QFM in its current directory - this
  107.     file is treated as an ordinary file, and may contain any text
  108.     and formatting commands that the user desires.
  109.  
  110.  
  111. AUTHOR
  112.     Orc (david parsons)
  113.